package com.athuiju.servicebase.config;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.service.Contact;

@Configuration      //因为是配置类，所以要加上@Configuration表示它是一个配置类
@EnableSwagger2 //因为是swagger所以要加上@EnableSwagger2注解，表示这个类就是做swagger整合的
public class SwaggerConfig {

    //下面的两个方法不用手写，直接复制就行，我们只需要做适当的修改就可以了

    /**
     * 配置swagger的一些插件
     * @return
     */
    @Bean
    public Docket webApiConfig(){

        //此方法可以改一改名字，其他都不用修改。
        return new Docket(DocumentationType.SWAGGER_2)//表示类型是swagger2
                .groupName("webApi")//表示可以分组，我们给组起个名字叫webApi
                .apiInfo(webApiInfo())//调用了下面的方法，设置了在线文档中的一些信息
                .select()//下面这些是一些固定结构
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))//当你的路径中包含有/admin/.  就不进行显示(不需要修改)
                .paths(Predicates.not(PathSelectors.regex("/error.*")))//当你的路径中包含有/error.  就不进行显示(不需要修改)
                .build();

    }

    /**
     * 设置了在线文档中的一些信息
     * @return
     */
    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.0")
                .contact(new Contact("Helen", "http://athuiju.com", "88888888@qq.com"))
                .build();
    }



}
